Class TXLSWorkbook

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TXLSWorkbook = class(TComponent)

Description

Hierarchy

  • TComponent
  • TXLSWorkbook

Overview

Methods

Public destructor Destroy; override;
Public procedure CreateMembers(AClassFactory: TXLSClassFactory; AManager: TXc12Manager; AFormulas: TXLSFormulaHandler);
Public function Count: integer;
Public procedure Delete(const AIndex: integer; ACount: integer = 1);
Public procedure Insert(const AIndex: integer; ACount: integer = 1);
Public procedure Clear;
Public procedure ClearCells;
Public function Add: TXLSWorksheet;
Public function SheetByName(const Name: AxUCString): TXLSWorksheet;
Public procedure AfterRead;
Public procedure BeforeWrite;
Public procedure CalcDimensions;
Public procedure CompileFormulas;
Public procedure Calculate;
Public function GetWeakPassword: AXUCString;
Public function MaxRowCount: integer;
Public function MaxColCount: integer;
Public function CopyCells(const ASrcSheet: integer; ASrcAreas: TBaseCellAreas; const ADestSheet,ADestCol,ADestRow: integer; CopyOptions: TCopyCellsOptions = [ccoAdjustCells] + CopyAllCells): boolean; overload;
Public procedure CopyCells(SrcSheet,Col1,Row1,Col2,Row2,DestSheet,DestCol,DestRow: integer; const CopyOptions: TCopyCellsOptions = [ccoAdjustCells] + CopyAllCells); overload;
Public procedure MoveCells(const SrcSheet,Col1,Row1,Col2,Row2,DestSheet,DestCol,DestRow: integer; const CopyOptions: TCopyCellsOptions = [ccoAdjustCells] + CopyAllCells);
Public procedure DeleteCells(const ASheet: integer; AAreas: TBaseCellAreas); overload;
Public procedure DeleteCells(const ASheet: integer; AArea: TCellArea); overload;
Public procedure DeleteCells(const ASheet, ACol1, ARow1, ACol2, ARow2: integer); overload;
Public procedure CopyColumns(const ASrcSheet,ACol1,ACol2,ADestSheet,ADestCol: integer);
Public procedure MoveColumns(const ASrcSheet,ACol1,ACol2,ADestSheet,ADestCol: integer);
Public procedure DeleteColumns(const ASheet,ACol1,ACol2: integer);
Public procedure ClearColumns(const ASheet,ACol1,ACol2: integer);
Public procedure InsertColumns(const ASheet,ACol,AColCount: integer);
Public procedure CopyRows(const ASrcSheet,ARow1,ARow2,ADestSheet,ADestRow: integer);
Public procedure MoveRows(const ASrcSheet,ARow1,ARow2,ADestSheet,ADestRow: integer);
Public procedure DeleteRows(const ASheet,ARow1,ARow2: integer);
Public procedure ClearRows(const ASheet,ARow1,ARow2: integer);
Public procedure InsertRows(const ASheet,ARow,ARowCount: integer);
Public procedure CopySheet(const ASrcSheet,ADestSheet: integer);
Public procedure BeginFindText;
Public function FindText(const Text: AxUCString; const CaseInsensitive: boolean = True): boolean;
Public procedure GetFindData(var Sheet,Col,Row,TextPos: integer; var Text: AxUCString);

Properties

Public property Backup: boolean read GetBackup write SetBackup;
Public property RefreshAll: boolean read GetRefreshAll write SetRefreshAll;
Public property UserName: AxUCString read GetUserName write SetUserName;
Public property NameAsFloat [constAName:AxUCString]: double read GetNameAsFloat write SetNameAsFloat;
Public property NameAsString [constAName:AxUCString]: AxUCString read GetNameAsString write SetNameAsString;
Public property NameAsFmtString [constAName:AxUCString]: AxUCString read GetNameAsFmtString;
Public property NameAsBoolean [constAName:AxUCString]: boolean read GetNameAsBoolean write SetNameAsBoolean;
Public property NameAsError [constAName:AxUCString]: TXc12CellError read GetNameAsError write SetNameAsError;
Public property NameAsFormula [constAName:AxUCString]: AxUCString read GetNameAsFormula write SetNameAsFormula;
Public property NameAsNumFormulaValue [constAName:AxUCString]: double read GetNameAsNumFormulaValue write SetNameAsNumFormulaValue;
Public property NameAsStrFormulaValue [constAName:AxUCString]: AxUCString read GetNameAsStrFormulaValue write SetNameAsStrFormulaValue;
Public property NameAsBoolFormulaValue[constAName:AxUCString]: boolean read GetNameAsBoolFormulaValue write SetNameAsBoolFormulaValue;
Public property DefaultName: AxUCString read FDefaultName write SetDefaultName;
Public property ShowFormulas: boolean read FShowFormulas write FShowFormulas;
Public property OptionsDialog: TXLSOptionsDialog read FOptionsDialog;
Public property WorkbookData: TXLSWorkbookData read FWorkbookData;
Public property Formulas: TXLSFormulaHandler read FFormulas;
Public property Names: TXLSNames read GetNames;
Public property InternalNames: TXLSNames read GetInternalNames;
Public property Palette[Index:integer]: TColor read GetPalette write SetPalette;
Public property BIFF: TBIFF5 read FBIFF;
Public property VBA: TXLSVBA read GetVBA;
Public property Clipboard: TXLSClipboard read FXLSClipboard;
Public property CmdFormat: TXLSCmdFormat read FCmdFormat;
Public property DefaultFormat: TXLSDefaultFormat read FDefaultFormat write FDefaultFormat;
Public property Font: TXc12Font read GetFont;
Public property SelectedTab: integer read FSelectedTab write FSelectedTab;
Public property DefaultPaperSize: TXc12PaperSize read FDefaultPaperSize write FDefaultPaperSize;
Public property Items[Index:integer]: TXLSWorksheet read GetItems;
Public property Sheets[Index:integer]: TXLSWorksheet read GetItems;

Description

Methods

Public destructor Destroy; override;
 
Public procedure CreateMembers(AClassFactory: TXLSClassFactory; AManager: TXc12Manager; AFormulas: TXLSFormulaHandler);
 
Public function Count: integer;
 
Public procedure Delete(const AIndex: integer; ACount: integer = 1);
 
Public procedure Insert(const AIndex: integer; ACount: integer = 1);
 
Public procedure Clear;
 
Public procedure ClearCells;
 
Public function Add: TXLSWorksheet;
 
Public function SheetByName(const Name: AxUCString): TXLSWorksheet;

Searches for a worksheet by it's name. ˜param Name The name of the worksheet. ˜result The TSheet object. If not found, Nil is returned.

Public procedure AfterRead;
 
Public procedure BeforeWrite;
 
Public procedure CalcDimensions;
 
Public procedure CompileFormulas;
 
Public procedure Calculate;
 
Public function GetWeakPassword: AXUCString;

Returns a password that can be used to unprotect worksheets. As the password is calculated, this may not be the same password used to protect it. ˜result A valid password that can unprotect the file. If there is no protection, an empty string is returned.

Public function MaxRowCount: integer;

The max number of rows in a worksheet. 65536 for Excel 97 and 1048576 for Excel 2007.

Public function MaxColCount: integer;

The max number of columns in a worksheet. 256 for Excel 97 and 16384 for Excel 2007.

Public function CopyCells(const ASrcSheet: integer; ASrcAreas: TBaseCellAreas; const ADestSheet,ADestCol,ADestRow: integer; CopyOptions: TCopyCellsOptions = [ccoAdjustCells] + CopyAllCells): boolean; overload;
 
Public procedure CopyCells(SrcSheet,Col1,Row1,Col2,Row2,DestSheet,DestCol,DestRow: integer; const CopyOptions: TCopyCellsOptions = [ccoAdjustCells] + CopyAllCells); overload;
 
Public procedure MoveCells(const SrcSheet,Col1,Row1,Col2,Row2,DestSheet,DestCol,DestRow: integer; const CopyOptions: TCopyCellsOptions = [ccoAdjustCells] + CopyAllCells);
 
Public procedure DeleteCells(const ASheet: integer; AAreas: TBaseCellAreas); overload;
 
Public procedure DeleteCells(const ASheet: integer; AArea: TCellArea); overload;
 
Public procedure DeleteCells(const ASheet, ACol1, ARow1, ACol2, ARow2: integer); overload;
 
Public procedure CopyColumns(const ASrcSheet,ACol1,ACol2,ADestSheet,ADestCol: integer);
 
Public procedure MoveColumns(const ASrcSheet,ACol1,ACol2,ADestSheet,ADestCol: integer);
 
Public procedure DeleteColumns(const ASheet,ACol1,ACol2: integer);
 
Public procedure ClearColumns(const ASheet,ACol1,ACol2: integer);
 
Public procedure InsertColumns(const ASheet,ACol,AColCount: integer);
 
Public procedure CopyRows(const ASrcSheet,ARow1,ARow2,ADestSheet,ADestRow: integer);
 
Public procedure MoveRows(const ASrcSheet,ARow1,ARow2,ADestSheet,ADestRow: integer);
 
Public procedure DeleteRows(const ASheet,ARow1,ARow2: integer);
 
Public procedure ClearRows(const ASheet,ARow1,ARow2: integer);
 
Public procedure InsertRows(const ASheet,ARow,ARowCount: integer);
 
Public procedure CopySheet(const ASrcSheet,ADestSheet: integer);
 
Public procedure BeginFindText;
 
Public function FindText(const Text: AxUCString; const CaseInsensitive: boolean = True): boolean;
 
Public procedure GetFindData(var Sheet,Col,Row,TextPos: integer; var Text: AxUCString);
 

Properties

Public property Backup: boolean read GetBackup write SetBackup;

The Backup property specifies whether Microsoft Excel should save backup versions of a file, when the file is opened with Excel.

Public property RefreshAll: boolean read GetRefreshAll write SetRefreshAll;

Set the RefreshAll property to True if all external data should be refreshed when the workbook is loaded by Excel.

Public property UserName: AxUCString read GetUserName write SetUserName;

The name of the creator of the workbook.

Public property NameAsFloat [constAName:AxUCString]: double read GetNameAsFloat write SetNameAsFloat;
 
Public property NameAsString [constAName:AxUCString]: AxUCString read GetNameAsString write SetNameAsString;
 
Public property NameAsFmtString [constAName:AxUCString]: AxUCString read GetNameAsFmtString;
 
Public property NameAsBoolean [constAName:AxUCString]: boolean read GetNameAsBoolean write SetNameAsBoolean;
 
Public property NameAsError [constAName:AxUCString]: TXc12CellError read GetNameAsError write SetNameAsError;
 
Public property NameAsFormula [constAName:AxUCString]: AxUCString read GetNameAsFormula write SetNameAsFormula;
 
Public property NameAsNumFormulaValue [constAName:AxUCString]: double read GetNameAsNumFormulaValue write SetNameAsNumFormulaValue;
 
Public property NameAsStrFormulaValue [constAName:AxUCString]: AxUCString read GetNameAsStrFormulaValue write SetNameAsStrFormulaValue;
 
Public property NameAsBoolFormulaValue[constAName:AxUCString]: boolean read GetNameAsBoolFormulaValue write SetNameAsBoolFormulaValue;
 
Public property DefaultName: AxUCString read FDefaultName write SetDefaultName;
 
Public property ShowFormulas: boolean read FShowFormulas write FShowFormulas;
 
Public property OptionsDialog: TXLSOptionsDialog read FOptionsDialog;
 
Public property WorkbookData: TXLSWorkbookData read FWorkbookData;
 
Public property Formulas: TXLSFormulaHandler read FFormulas;
 
Public property Names: TXLSNames read GetNames;
 
Public property InternalNames: TXLSNames read GetInternalNames;
 
Public property Palette[Index:integer]: TColor read GetPalette write SetPalette;

The palette for the colors used by Excel. The palette has 64 entries, but the first 8 are fixed and can not be changed.

Public property BIFF: TBIFF5 read FBIFF;
 
Public property VBA: TXLSVBA read GetVBA;
 
Public property Clipboard: TXLSClipboard read FXLSClipboard;
 
Public property CmdFormat: TXLSCmdFormat read FCmdFormat;
 
Public property DefaultFormat: TXLSDefaultFormat read FDefaultFormat write FDefaultFormat;
 
Public property Font: TXc12Font read GetFont;
 
Public property SelectedTab: integer read FSelectedTab write FSelectedTab;
 
Public property DefaultPaperSize: TXc12PaperSize read FDefaultPaperSize write FDefaultPaperSize;
 
Public property Items[Index:integer]: TXLSWorksheet read GetItems;
 
Public property Sheets[Index:integer]: TXLSWorksheet read GetItems;
 

Generated by PasDoc 0.12.1 on 2013-03-18 12:36:48